--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
libs/able/docs/api.rst master (8b8a5035) Text, 2.87 KB
Tc9d1d9API
Tc9d1d9---
Tb4b4b4.. Tff7b72automoduleTb4b4b4:: able
Tc9d1d9Client
Tc9d1d9^^^^^^
Tc9d1d9BluetoothDispatcher
Tc9d1d9"""""""""""""""""""
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: BluetoothDispatcher
T56d364:members: adapter,
gatt,
bonded_devices,
name,
set_queue_timeout,
start_scan,
stop_scan,
connect_by_device_address,
connect_gatt,
close_gatt,
discover_services,
enable_notifications,
write_descriptor,
write_characteristic,
read_characteristic,
update_rssi,
request_mtu,
on_error,
on_gatt_release,
on_scan_started,
on_scan_completed,
on_device,
on_bluetooth_adapter_state_changeable,
on_connection_state_change,
on_services,
on_characteristic_changed,
on_characteristic_read,
on_characteristic_write,
on_descriptor_read,
on_descriptor_write,
on_rssi_updated,
on_mtu_changed,
Tc9d1d9Decorators
Tc9d1d9""""""""""
Tb4b4b4.. Tff7b72autofunctionTb4b4b4:: require_bluetooth_enabled
Tc9d1d9Advertisement
Tc9d1d9"""""""""""""
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: Advertisement
Tb4b4b4 .. Tff7b72autoclassTb4b4b4:: able::Advertisement.ad_types
Tc9d1d9Services
Tc9d1d9""""""""
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: Services
T56d364:members:
Tc9d1d9Constants
Tc9d1d9"""""""""
Tb4b4b4.. Tff7b72autodataTb4b4b4:: GATT_SUCCESS
Tb4b4b4.. Tff7b72autodataTb4b4b4:: STATE_CONNECTED
Tb4b4b4.. Tff7b72autodataTb4b4b4:: STATE_DISCONNECTED
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: AdapterState
T56d364:members:
T56d364:member-order: bysource
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: WriteType
T56d364:members:
Tc9d1d9Permissions
Tc9d1d9^^^^^^^^^^^
Tb4b4b4.. Tff7b72automoduleTb4b4b4:: able.permissions
Tb4b4b4.. Tff7b72automoduleTb4b4b4:: able
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: Permission
T56d364:members:
T56d364:undoc-members:
T56d364:member-order: bysource
Tc9d1d9Scan settings
Tc9d1d9^^^^^^^^^^^^^
Tb4b4b4.. Tff7b72automoduleTb4b4b4:: able.scan_settings
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: ScanSettingsBuilder
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: ScanSettings
>>> settings = ScanSettingsBuilder() \
T8b949e... .setMatchMode(ScanSettings.MATCH_MODE_AGGRESSIVE) \
T8b949e... .setCallbackType(
T8b949e... ScanSettings.CALLBACK_TYPE_FIRST_MATCH |
T8b949e... ScanSettings.CALLBACK_TYPE_MATCH_LOST
T8b949e... )
Tc9d1d9Scan filters
Tc9d1d9^^^^^^^^^^^^
Tb4b4b4.. Tff7b72automoduleTb4b4b4:: able.filters
T56d364:members:
T56d364:member-order: bysource
T56d364:show-inheritance:
Tc9d1d9Advertising
Tc9d1d9^^^^^^^^^^^
Tb4b4b4.. Tff7b72automoduleTb4b4b4:: able.advertising
Tc9d1d9Advertiser
Tc9d1d9""""""""""
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: Advertiser
T56d364:members:
T56d364:member-order: bysource
Tc9d1d9Payload
Tc9d1d9"""""""
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: AdvertiseData
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: DeviceName
T56d364:show-inheritance:
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: TXPowerLevel
T56d364:show-inheritance:
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: ServiceUUID
T56d364:show-inheritance:
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: ServiceData
T56d364:show-inheritance:
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: ManufacturerData
T56d364:show-inheritance:
Tc9d1d9Constants
Tc9d1d9"""""""""
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: Interval
T56d364:members:
T56d364:member-order: bysource
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: TXPower
T56d364:members:
T56d364:member-order: bysource
Tb4b4b4.. Tff7b72autoclassTb4b4b4:: Status
T56d364:members:
T56d364:undoc-members:
T56d364:member-order: bysource
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────